home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 6 / CU Amiga Magazine's Super CD-ROM 06 (1996)(EMAP Images)(GB)(Track 1 of 4)[!][issue 1997-01].iso / cucd / online / fidonetts / fsc-0086.001 < prev    next >
Text File  |  1995-09-03  |  7KB  |  172 lines
  1.  
  2.   | Document: FSC-0086
  3.   | Version:  001
  4.   | Date:     03 September 1995
  5.   |
  6.   | Mirko Mucko, 2:2433/920
  7.  
  8.  
  9.                 Information / Description of a new standard
  10.  
  11.                                 S  tandard
  12.                                 R  equest
  13.                                 I  nformation
  14.                                 F  ile
  15.  
  16.            Copyright (c) 1994,95 by Gordian Schuermann & Mirko Mucko
  17.  
  18. I  Overview
  19.                 Introduction                            0
  20.                 Description in general                  1
  21.                   Required statements                   1.1
  22.                   Optional statements                   1.2
  23.                   Undefined options                     1.3
  24.                 Implementation                          2.0
  25.  
  26.  
  27.  
  28.  
  29. 0. Introduction
  30.  In common, more and more mailer are about to implement the ability to
  31.  call external request processors. But very soon, we discovered a command
  32.  line cannot handle all the information the mailer has and the ERP needs.
  33.  
  34.  To transfer the information in a proper and fast way, we designed and
  35.  implemented the S R I F option in the mean it will be a standard soon.
  36.  
  37.  The structure and idea is protected by copyright law, except these
  38.  circumstances:
  39.  
  40.         +  you may distrubute, use and implement this structure for free
  41.         +  you have not to pay any value for usage of these methodes
  42.         +  you should note in your documentation the origin of SRIF
  43.  
  44. 1. Descritption
  45.  The SRIF name is the only parameter given from the Mailer to the External
  46.  Request Processor. The file is designated as a so called "plain vanilla ASCII"
  47.  file, filled with pre-defined, optional and not-yet defined statemets.
  48.  
  49.  We discussed the possibility of binary files, and of EMSI-like files, but
  50.  a plain ASCII control file is more flexible and can be read faster by
  51.  various program languages (C, Pascal, Basic, Cobol ect).
  52.  
  53.  In the SRIF, one command plus parameter is allowed per line, the file
  54.  is unlimited in length, comments are not allowed.
  55.  
  56.  The SRIF is generated by the Mailer and after the ERP finished its work,
  57.  the Mailer is responsible for erasing the SRIF.
  58.  
  59. 1.1 Required statements
  60.  The following statements are required for the ERP:
  61.  
  62.  
  63.        Sysop            <Sysop_Name>
  64.                         This is the name of the remote sysop
  65.  
  66.        AKA              <Zone:Net/Node[.Point][@Domain]>
  67.                         This is the main aka of the remote system in 4D or
  68.                         5D notation. A zero as point number may be ommited,
  69.                         the domain with "@" is optional
  70.  
  71.        Baud             <Current LINE rate>
  72.                         This is the effective baud rate, not the fixed DTE rate
  73.  
  74.        Time             <Time in minutes>
  75.                         This is the time till next event which does not allow
  76.                         file requests. Use -1 if no limits
  77.  
  78.        RequestList      <File of request list>
  79.                         This is the filename of the list containing requested
  80.                         files.
  81.        ResponseList     <File of response list>
  82.                         This is the filename of the response list.
  83.                         It must not be equal to RequestList. One file per line,
  84.                         including drives/pathes to the file. The first
  85.                         character defines the way the mailer should act after
  86.                         sending that file:
  87.  
  88.                          =   erase file if sent successfully
  89.                          +   do not erase the file after sent
  90.                          -   erase the file in any case after session
  91.  
  92.        RemoteStatus     <PROTECTED or UNPROTECTED>
  93.                         Defines whether the session is protected by password
  94.                         or not
  95.  
  96.        SystemStatus     <LISTED or UNLISTED>
  97.                         Defines whether the remote system is listed in any
  98.                         current nodelist of system.
  99.  
  100. 1.2 Optional statements
  101.  These parameters are already known and defined, but a ERP should run also
  102.  without them:
  103.  
  104.        SessionProtocoll <e.g. ZAP,ZMO,XMA
  105.  
  106.        AKA              <Zone:Net/Node[.Point][@Domain]>
  107.                         Additional AKAs. One AKA is required (see REQUIRED
  108.                         section)
  109.  
  110.        Site             <Site Info>
  111.                          The site info as given e.g. in EMSI handshake
  112.  
  113.        Location         <Location and/or ZIP>
  114.                          The location info as given e.g. in EMSI handshake
  115.  
  116.        Phone            <Phone Number>
  117.                          The  phone number info as given e.g. in EMSI handshake
  118.  
  119.        Password         <Session password>
  120.                          On protected sessions, the session password. If
  121.                          no protected session, this parameter must be ommited!
  122.  
  123.        DTE              <Current DTE rate>
  124.                          The PC<->Modem speed (so call DTE rate)
  125.  
  126.        PORT             <COM Port from 1 to 8>
  127.                          The FOSSIL Communication Port. The Mailer should
  128.                          leave the fossil "hot" for the Request Processor
  129.  
  130.        Mailer           <Remote's mailer if EMSI>
  131.                           The Mailer name as defined by FTC
  132.  
  133.        MailerCode       <Remote's FTSC code>
  134.                           The hex code of the remote mailer as defined by FTC
  135.  
  136.        SerialNumber     <Remote's serial number if passed>
  137.                          The remote mailer's serial number if transfered
  138.  
  139.        Version          <Remote's version number if EMSI>
  140.                          The remote mailer's version number if transfered
  141.  
  142.        Revision         <remote's revision number if EMSI>
  143.                          The remote mailer's revision number if transfered
  144.  
  145.        SessionType      <may be EMSI, FTSC0001, WAZOO, JANUS, HYDRA or OTHER>
  146.                          The session-type, this may be one of the known
  147.                          session types or "OTHER" if not (yet) defined
  148.  
  149.        OurAKA           <AKA which has been called for proper response>
  150.                          If the mailer does AKA matching, the AKA of the
  151.                          mailer being called
  152.  
  153.        TRANX            <Tranx Line as 8 digit hex string>
  154.                          The unix-style time stamp (hexadecimal notation
  155.                          of seconds since 1.1.1980)
  156.  
  157. 1.3 Undefined options
  158.  There may be the need to add new commands / parameters to the SRI file. If
  159.  so, they may be added, but inform us to keep the documentation "up to date"
  160.  and to share your good ideas with other autors of software for FIDONet.
  161.  
  162.  
  163. 2.0 Implementation
  164.  SRIF is implemented in these fine products already :
  165.  
  166.                 Mailer                  Request Processor
  167.                 ------------------------------------------------------
  168.                 McMail                  xOR
  169.                                         EasyERP
  170.  
  171.  Other products will follow soon !
  172.